Saving and Loading a Configuration Package File

You can save and load a bundle of files used by the device in a single, packaged file called a Configuration Package file. This file is in 7-Zip archive file format (.7z) and uses the LZMA2 compression algorithm. In addition, you can optionally password-protect the file and encrypt it using the AES-256 algorithm.

The feature can be used for backing up full configuration and then later restoring it to the device in case of device configuration failure (for whatever reason), or for loading the backed-up configuration package file to other devices requiring similar configuration.

The configuration package file can include the following files:

File	Description
cli-startup-script.txt	CLI Startup Script file.
<TLS Context ID>.pkey	Private key of the TLS Context (by ID). Note: You can only choose to include certificates in the Configuration Package file if you enable the password-protect (encrypt) option.
<TLS Context ID>.crt	TLS certificate of the TLS Context (by ID). Note: You can only choose to include certificates in the Configuration Package file if you enable the password-protect (encrypt) option.
<TLS Context ID>.root	Trusted root certificate of the TLS Context (by ID). Note: You can only choose to include certificates in the Configuration Package file if you enable the password-protect (encrypt) option.
LOGO.dat	Image file used as the logo in the Web interface.
FAVICON.dat	Favicon file used by Web browsers to represent the device's Web interface.
CPT.dat	Call Progress Tone file (CPT).
PRT.dat	Pre-recorded Tone file (PRT).
AMD.dat	Answer Machine Detection file (AMD).
DPLN.dat	Dial Plan file. Note: Only for backward compatibility for versions that supported a Dial Plan file. For current versions, the Dial Plan is included in the ini file.
DialPlanRule.csv	Dial Plan file.

●

When loading a Configuration Package file, the device needs to reset for the settings to take effect.

●

You can manually add TLS certificate files (i.e., <ctx_id>.crt, <ctx_id>.root, or <ctx_id>.pkey) to an already downloaded Configuration Package file and then upload it to the device.

●

For the certificate files, only the root certificate file (.root) can be saved.

●

When loading a Configuration Package file, the filenames must be as listed above.

●

By default, the Configuration Package file is saved with the filename "ConfBackupPkg<Serial Number>.7z".

●

The Configuration Package file is included in the device's debug file and core dump file (see Viewing Debug (and Core Dump) File Contents.

●

For backward compatibility, a Configuration Package file in TAR format (.tar.gz) can still be uploaded to the device.

You can save and load a Configuration Package file using the following methods:

■

CLI:

# copy configuration-pkg from|to <URL> [encrypted <password>] [certificates]

●

For uploading a Configuration File that is password-protected, use the encrypted option to specify the password: copy configuration-pkg from <URL> encrypted <password>

●

For downloading the Configuration File, if you want to password-protect it (and optionally include the TLS certificates), use the encrypted and certificates options, respectively: copy configuration-pkg from <URL> encrypted <password> certificates

■

Auto-Update Feature: To load the Configuration Package file through the Auto-Update mechanism, use the [ConfPackageURL] ini file parameter.

If the file is password-protected, specify the password using the following CLI command:

(config-system)# automatic-update
(auto-update)# default-configuration-package-password <password>

■

SFTP: The Configuration Package file can also be downloaded (Get) from the device through SFTP. The file is located in the /configuration directory. Your SFTP client needs to authenticate itself with the SFTP server (i.e., the device) and access is granted only to users with Security Administrator level.

●

When the file is password-protected, it includes the TLS certificates and the file is listed in the device's /configuration directory as configuration-package-full.7z. If it's not password-protected (and therefore, doesn't include certificates), the file is listed as configuration-package.7z.

●

The password for protecting the file is specified as described for the Auto-Update mechanism (see above).

■

Web interface:

Open the Configuration File page:

◆

Toolbar: From the Actions drop-down menu, choose Configuration File

◆

Navigation tree:Setup menu > Administration tab > Maintenance folder > Configuration File

To download the Configuration Package file:

Click the Save Configuration Package button, and then save the file to a folder on your computer.

ii.

To password-protect the file, select the 'Encrypted Configuration Package' check box.

iii.

Click the Download Configuration Package button; if the 'Encrypted Configuration Package' check box was selected, the following dialog box appears (otherwise, the file is downloaded to your computer):

iv.

In the 'Password' and 'Verify' fields, type the password to protect the file.

To include the TLS certificates, select the 'Include Private Keys and device Certificates' check box.

vi.

Click Yes.

To upload a Configuration Package file:

If the file is password-protected, select the 'Encrypted Configuration Package' check box.

ii.

Click the Browse button, and then browse to and select the file on your computer.

iii.

Click the Load Configuration Package button; the following message box appears, informing you that the device will reset after the file is loaded.

If the file is not password-protected (i.e., you didn't select the check box in Step i), the following appears:

If the file is password-protected (i.e., you selected the check box in Step i), the following appears:

iv.

If the file is password-protected, in the 'Password' field, type the password.

Click Yes to continue (or No to cancel the file load). If you click Yes, the device loads the file and then resets with a save to flash for the settings to take effect.